Skip to content

docs(ack-id): fix README typo, link, and type guard exports - #188

Open
crazywriter1 wants to merge 2 commits into
agentcommercekit:mainfrom
crazywriter1:docs/ack-id-readme-fix
Open

docs(ack-id): fix README typo, link, and type guard exports#188
crazywriter1 wants to merge 2 commits into
agentcommercekit:mainfrom
crazywriter1:docs/ack-id-readme-fix

Conversation

@crazywriter1

@crazywriter1 crazywriter1 commented Sep 1, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Problem

The ack-id README had three copy-paste issues:

  • The A2A handshake example started with t const response, which is invalid TypeScript.
  • The demo link used ../docs/demos/demo-identity-a2a.mdx, which resolves to packages/docs/... and 404s from the package README. The file lives at docs/demos/demo-identity-a2a.mdx.
  • The README documented isControllerClaim, which is not exported from the package. The public type guard is isControllerCredential.

Fix

Correct the typo, fix the relative link to ../../docs/demos/demo-identity-a2a.mdx, and document only the exported isControllerCredential API.

No changeset: documentation-only README fix with no runtime or API change.

AI usage

Per AI_POLICY.md, Cursor found these during a docs scan of main. I read the diff before opening this.

Summary by CodeRabbit

  • Documentation
    • Updated usage examples and API documentation to remove the deprecated isControllerClaim reference.
    • Corrected the A2A demo link.
    • Reformatted handshake examples for improved readability and accuracy.

venables
venables previously approved these changes Sep 1, 2026
View reviewed changes

@venables venables left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @crazywriter1 !

@venables

venables commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

@crazywriter1 mind running the formatter on this again?

@coderabbitai

coderabbitai Bot commented Sep 1, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 3661e32f-91ea-4697-b11f-36217e25d64d

📥 Commits

Reviewing files that changed from the base of the PR and between 7e4a25f and b1db411.

📒 Files selected for processing (1)
  • packages/ack-id/README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.

Walkthrough

The ack-id README removes isControllerClaim documentation, corrects the A2A demo link, and reformats the A2A handshake example.

Changes

ack-id README updates

Layer / File(s) Summary
Update API and A2A documentation
packages/ack-id/README.md		 The README removes the isControllerClaim example and API entry. It corrects the A2A demo link and handshake example formatting.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to b1db4

This documentation-only change corrects the handshake example, demo link, and exported type-guard documentation without changing runtime behavior or the public implementation; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: venables

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation fixes in the ack-id README, including the typo, demo link, and type guard export reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@crazywriter1

crazywriter1 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review sir.. Done. Ran the formatter on the README. CI should pass now. @venables

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@venables venables Awaiting requested review from venables

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@crazywriter1 @venables